Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "What's New" page to show release notes after update to new version #1414

Merged
merged 1 commit into from
Jul 9, 2023

Conversation

ychin
Copy link
Member

@ychin ychin commented Jul 8, 2023

Currently when a user uses Sparkle updater to update, they will see the release notes beforehand. However, if they are updating across multiple versions, they only see the latest one. Also, if they are using automatic update, they will not see the release notes page. Users who get MacVim from Homebrew or manually building from source also do not see the release notes as those mechanisms are driven from command line. This makes it harder to communicate new features and announcements to these users.

Add a new "What's New" page that will be automatically shown whenever the user has updated to a new version of MacVim. The last version of MacVIm is tracked by the MMLastUsedBundleVersion value previously added in #1357, which allows us to detect such update no matter what installation method was used and display a dialog box. Other than opening at launch, the user can also open it in the Help menu, and there's an option to make it not open at launch if it's annoying to the user.

The release notes is served by http://macvim.org/ (done in macvim-dev/macvim-dev.github.io#1) so we don't have to bundle it locally and it makes it easier to update them. MacVim will know the request a range of release notes (if updating across multiple versions at once) so that all new versions will be visible.

Also, fix it so that both Sparkle updater and the new What's New page will properly be shown on top of the new MacVim window that gets opened when MacVim is launched. Previously when we get a new update, Sparkle frequently gets hid behind the editor window.

@ychin ychin added the Updater Issues related to Sparkle updater label Jul 8, 2023
@ychin ychin added this to the Release 177 milestone Jul 8, 2023
Currently when a user uses Sparkle updater to update, they will see the
release notes beforehand. However, if they are updating across multiple
versions, they only see the latest one. Also, if they are using
automatic update, they will not see the release notes page. Users who
get MacVim from Homebrew or manually building from source also do not
see the release notes as those mechanisms are driven from command line.
This makes it harder to communicate new features and announcements to
these users.

Add a new "What's New" page that will be automatically shown whenever
the user has updated to a new version of MacVim. The last version of
MacVIm is tracked by the MMLastUsedBundleVersion value previously added
in macvim-dev#1357, which allows us to detect such update no matter what
installation method was used and display a dialog box. Other than
opening at launch, the user can also open it in the Help menu, and
there's an option to make it not open at launch if it's annoying to
the user.

The release notes is served by http://macvim.org/ (done in
macvim-dev/macvim-dev.github.io#1) so we don't
have to bundle it locally and it makes it easier to update them. MacVim
will know the request a range of release notes (if updating across
multiple versions at once) so that all new versions will be visible.

Also, fix it so that both Sparkle updater and the new What's New page
will properly be shown on top of the new MacVim window that gets opened
when MacVim is launched. Previously when we get a new update, Sparkle
frequently gets hid behind the editor window.
@ychin ychin merged commit dd12536 into macvim-dev:master Jul 9, 2023
@ychin ychin deleted the whats-new-page branch July 9, 2023 06:24
ychin added a commit that referenced this pull request Jul 10, 2023
Updated to Vim 9.0.1677

Announcements
====================

Website
--------------------

The official website for MacVim is now https://macvim.org. Previously it just
forwarded to https://macvim-dev.github.io/macvim/. You can also read the MacVim
documentation at https://macvim.org/docs/gui_mac.txt.html. #1385

Features
====================

Updater / What's New page
--------------------

There is now a "What's New" page that will automatically be shown whenever
MacVim detected that it has been updated to a new version (can be disabled in
Settings). The page will also include all the release notes if you have
updated across multiple versions. This feature is useful for users who turned
on "Automatically install updates" or installs MacVim through other methods
like Homebrew but would still like to see the release notes when a new version
comes out. You can also access it through the Help menu. #1414

MacVim should now report its version in a much more consistent manner in the
"About MacVim" page and when the updater reports there is a new version. It
should look something like "r176 (Vim 9.0.1276)" where "r176" is the MacVim
release number and the 9.0.1276 is the bundled Vim version. #1293 #1393

Sparkle (updater for MacVim) is now updated to 2.4.2. #1416

New Vim features
--------------------

- New bundled colorschemes: wildcharm/retrobox/sorbet/zaibatsu (vim/vim#12163)
- File encryption now has a new `cryptmethod`: `xchacha20v2`, which is designed
  to be more forward compatible with future Vim versions than `xchacha20`.
  (v9.0.1481)
- `switchbuf` works for more commands. (v9.0.1546)
- Statusline now supports multiple alignment "%=" items. (v9.0.1300)
- New UTF-16 utility functions (`strutf16len` and `utf16idx`) (v9.0.1485)
- Misc 'smoothscroll' bugs fixes

General
====================

* Removed non-Unicode localization files, which helps cut down on app size. #1397
* Miscellaneous documentation fixes. #1415 #1375 #1386 #1363 (by @dkav)
* The disk image for MacVim (MacVim.dmg) is now in APFS and uses better
  compression for better efficiency. #1409

Fixes
====================

* Printing a file in macOS 13 Ventura (using `:hardcopy` or File→Print) should
  work again. #1390
* Fixed a broken symlink to XPCServices in the Sparkle framework. #1367
* Fixed MacVim to not throw (safe) Objective C exceptions when quitting. #1371
* Fixed welcome message not being aligned properly in Simplified Chinese and
  show the Vim 9 prompt. #1381
* Removed some unnecessary test files in the runtime folders which were
  included erroneously. #1418

Scripting
====================

- Scripting languages versions:
    - Python is now built against 3.11, up from 3.10.

Compatibility
====================

Requires macOS 10.9 or above. (10.9 - 10.12 requires downloading a
separate legacy build)

Script interfaces have compatibility with these versions:

- Lua 5.4
- Perl 5.30
- Python2 2.7
- Python3 3.11
- Ruby 3.2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Updater Issues related to Sparkle updater
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant